Skip to content

Add Glossary #237

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 5 commits into
base: main
Choose a base branch
from
Draft

Conversation

uvidyadharan
Copy link
Member

No description provided.

@uvidyadharan uvidyadharan marked this pull request as draft July 20, 2024 14:29
@emcclurg
Copy link
Contributor

Needs reference to GM1 changed to Competition Manual. @uvidyadharan

@acharraggi
Copy link
Collaborator

I had a look at this PR and tried to build it. I had to change it to Sphinx 5, but it built locally and I could see the hover effect on the link on the CAD page.

I was worried the tool tip (hover) would not be accessible. It doesn't activate when tabbed to the link via keyboard, and the screen reader reads the link normally without anything extra. However, I think the accessibility is fine because a keyboard user or screen reader user can click the link to go to the glossary definition. The problem with tool tips is some apps/webpages don't provide an alternate way to see the text that pops up. In this case the user can click the link to see the text.

We should replace Game Manual 1 and (GM1) references with Competition Manual or (CM) on the glossary page.
OpMode is listed twice, an item shouldn't be listed twice in a glossary.
The terms should be alphabetical in the glossary.
I wasn't sure we needed to highlight the GM1 terms on the glossary page, but it may be useful for readers to know that some terms are specified in the Competition Manual, so probably worth keeping.

I'd like to see this deployed sooner than later, and I'm willing to work on it.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants